org.eclipse.vtp.framework.interactions.core.commands
Class InitialCommand

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand
      org.eclipse.vtp.framework.interactions.core.commands.InitialCommand

All Implemented Interfaces:

ICommand

public class InitialCommand
extends ConversationCommand

InitialCommand.

Author:

Lonnie Pryor

Field Summary

Fields inherited from class org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand

INPUT_TYPE_CUSTOM, INPUT_TYPE_FILE, OUTPUT_TYPE_FILE, OUTPUT_TYPE_TEXT

Constructor Summary

InitialCommand()
Creates a new InitialCommand.

Method Summary

java.lang.Object	exportContents() Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.
java.lang.String[]	getParameterNames() Returns the names of the parameters that will be returned from the interaction.
java.lang.String[]	getParameterValues(java.lang.String name) Returns the values of a parameter to be set when the process resumes.
java.lang.String	getResultName() Returns the name of the parameter to pass the result of the request as.
java.lang.String	getResultValue() Returns the value of the result parameter to pass if the input is valid.
java.lang.String[]	getVariableNames() getVariableNames.
java.lang.String	getVariableValue(java.lang.String name) Returns the values of a variable to be set when the process resumes.
void	importContents(java.lang.Object contents) Configures the contents of this command with a structure previously returned from ICommand.exportContents().
boolean	removeVariable(java.lang.String name) removeVariable.
void	setParameterValues(java.lang.String name, java.lang.String[] values) Configures a parameter set when the current process resumes.
void	setResultName(java.lang.String resultName) Sets the name of the parameter to pass the result of the request as.
void	setResultValue(java.lang.String resultValue) Sets the value of the result parameter to pass if the input is valid.
boolean	setVariable(java.lang.String name, java.lang.String value) setVariable.

Methods inherited from class org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand

accept

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InitialCommand

public InitialCommand()

Creates a new InitialCommand.

Method Detail

getResultName

public java.lang.String getResultName()

Returns the name of the parameter to pass the result of the request as.

Returns:

The name of the parameter to pass the result of the request as.

setResultName

public void setResultName(java.lang.String resultName)

Sets the name of the parameter to pass the result of the request as.

Parameters:

resultName - The name of the parameter to pass the result of the request as.

getResultValue

public java.lang.String getResultValue()

Returns the value of the result parameter to pass if the input is valid.

Returns:

The value of the result parameter to pass if the input is valid.

setResultValue

public void setResultValue(java.lang.String resultValue)

Sets the value of the result parameter to pass if the input is valid.

Parameters:

resultValue - The value of the result parameter to pass if the input is valid.

getVariableNames

public java.lang.String[] getVariableNames()

getVariableNames.

Returns:

getVariableValue

public java.lang.String getVariableValue(java.lang.String name)

Returns the values of a variable to be set when the process resumes.

Parameters:

name - The name of the variable to be set.

Returns:

The values that specified variable will be set to.

setVariable

public boolean setVariable(java.lang.String name,
                           java.lang.String value)

setVariable.

Parameters:

name -

Returns:

removeVariable

public boolean removeVariable(java.lang.String name)

removeVariable.

Parameters:

name -

Returns:

getParameterNames

public java.lang.String[] getParameterNames()

Returns the names of the parameters that will be returned from the interaction.

Returns:

The names of the parameters that will be returned from the interaction.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Returns the values of a parameter to be set when the process resumes.

Parameters:

name - The name of the parameter to be set.

Returns:

The values that specified parameter will be set to.

setParameterValues

public void setParameterValues(java.lang.String name,
                               java.lang.String[] values)

Configures a parameter set when the current process resumes.

Parameters:

name - The name of the parameter to set.

values - The values to set the parameter to.

exportContents

public java.lang.Object exportContents()

Description copied from interface: ICommand

Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.

Returns:

A serializable structure this command can be re-constituted from.

importContents

public void importContents(java.lang.Object contents)

Description copied from interface: ICommand

Configures the contents of this command with a structure previously returned from ICommand.exportContents().

Parameters:

contents - The exported contents structure to load from.